sprig-reap 0.0.6 → 0.0.7

data/README.md

@@ -35,17 +35,59 @@ after the STI base model.  STI sub-type records will all be written to that file
 
 ### Additional Configuration
 
-Don't like the defaults when reaping Sprig::Reap records? You may specify the target environment
-(`db/seeds` target folder), models (`ActiveRecord::Base.subclasses`-only) you want seed files for,
-or any ignored attributes you don't want to show up in any of the seed files.
+Don't like the defaults when reaping Sprig::Reap records? Change 'em!
 
+#### Target Environment
+You may specify the target environment (`db/seeds` target folder):
 ```
 # Rake Task
-rake db:seed:reap TARGET_ENV=integration MODELS=User,Post IGNORED_ATTRS=created_at,updated_at
+rake db:seed:reap TARGET_ENV=integration
 
 # Rails Console
-Sprig.reap(target_env: 'integration', models: [User, Post], ignored_attrs: [:created_at,
-:updated_at])
+Sprig.reap(target_env: 'integration')
+```
+
+#### Model List
+If you only want to `reap` a subset of your models, you may provide a list of models
+(`ActiveRecord::Base.subclasses`-only) you want seed files for:
+```
+# Rake Task
+rake db:seed:reap MODELS=User,Post
+
+# Rails Console
+Sprig.reap(models: [User, Post])
+```
+
+#### Ignored Attributes
+If there are any ignored attributes you don't want to show up in any of the seed files, let `reap`
+know:
+```
+# Rake Task
+rake db:seed:reap IGNORED_ATTRS=created_at,updated_at
+
+# Rails Console
+Sprig.reap(ignored_attrs: [:created_at, :updated_at])
+```
+
+#### Omitting Empty Attributes
+If you have models with lots of attributes that could potentially be `nil`/empty, the resulting seed
+files could get cluttered with all the `nil` values.  Remove them from your seed files with:
+```
+# Rake Task
+rake db:seed:reap OMIT_EMPTY_ATTRS=true
+
+# Rails Console
+Sprig.reap(omit_empty_attrs: true)
+```
+
+#### Combine Them All!
+You're free to take or leave as many options as you'd like:
+```
+# Rake Task
+rake db:seed:reap TARGET_ENV=integration MODELS=User,Post IGNORED_ATTRS=created_at,updated_at OMIT_EMPTY_ATTRS=true
+
+# Rails Console
+Sprig.reap(target_env: 'integration', models: [User, Post], ignored_attrs: [:created_at, :updated_at], omit_empty_attrs: true)
 ```
 
 ### Adding to Existing Seed Files (`.yaml` only)

data/lib/sprig/reap.rb

@@ -9,18 +9,26 @@ module Sprig::Reap
   autoload :Record,        'sprig/reap/record'
   autoload :SeedFile,      'sprig/reap/seed_file'
   autoload :FileAttribute, 'sprig/reap/file_attribute'
+  autoload :Logging,       'sprig/reap/logging'
+
+  extend Logging
 
   class << self
     def reap(input = {})
       options = input.to_hash
 
       configure do |config|
-        config.target_env    = options[:target_env]    || options['TARGET_ENV']
-        config.classes       = options[:models]        || options['MODELS']
-        config.ignored_attrs = options[:ignored_attrs] || options['IGNORED_ATTRS']
+        config.target_env       = options[:target_env]       || options['TARGET_ENV']
+        config.classes          = options[:models]           || options['MODELS']
+        config.ignored_attrs    = options[:ignored_attrs]    || options['IGNORED_ATTRS']
+        config.omit_empty_attrs = options[:omit_empty_attrs] || options['OMIT_EMPTY_ATTRS']
       end
 
+      log_debug "Reaping records from the database...\r"
+
       Model.all.each { |model| SeedFile.new(model).write }
+
+      log_debug "Finished reaping!"
     end
 
     def clear_config
@@ -34,6 +42,8 @@ module Sprig::Reap
     delegate :target_env,
              :classes,
              :ignored_attrs,
+             :logger,
+             :omit_empty_attrs,
              to: :configuration
 
     def configuration

data/lib/sprig/reap/configuration.rb

@@ -29,6 +29,18 @@ module Sprig::Reap
       @ignored_attrs = parse_ignored_attrs_from(input)
     end
 
+    def logger
+      @logger ||= Logger.new($stdout)
+    end
+
+    def omit_empty_attrs
+      @omit_empty_attrs ||= false
+    end
+
+    def omit_empty_attrs=(input)
+      @omit_empty_attrs = true if String(input).strip.downcase == 'true'
+    end
+
     private
 
     def valid_classes

data/lib/sprig/reap/logging.rb

@@ -0,0 +1,35 @@
+module Sprig::Reap
+  module Logging
+    LOG_LEVELS = {
+      debug: :blue,
+      info:  :green,
+      warn:  :orange,
+      error: :red
+    }
+
+    LOG_COLORS = {
+      blue:   34,
+      green:  32,
+      orange: 33,
+      red:    31
+    }
+
+    LOG_LEVELS.each do |level, color|
+      define_method("log_#{level}") do |message|
+        Sprig::Reap.logger.send(level, send(color, message.to_s))
+      end
+    end
+
+    private
+
+    def colorize(message, color_code)
+      "\e[#{color_code}m#{message}\e[0m"
+    end
+
+    LOG_COLORS.each do |name, color_code|
+      define_method(name) do |message|
+        colorize(message, color_code)
+      end
+    end
+  end
+end

data/lib/sprig/reap/model.rb

@@ -1,5 +1,7 @@
 module Sprig::Reap
   class Model
+    include Logging
+
     def self.all
       @@all ||= begin
         models = Sprig::Reap.classes.map { |klass| new(klass) }
@@ -52,6 +54,8 @@ module Sprig::Reap
     end
 
     def to_yaml(options = {})
+      return if records.empty?
+
       namespace         = options[:namespace]
       formatted_records = records.map(&:to_hash)
 
@@ -66,6 +70,9 @@ module Sprig::Reap
 
     def records
       @records ||= klass.all.map { |record| Record.new(record, self) }
+    rescue
+      log_error "Encountered an error when pulling the database records for #{to_s}...\r"
+      []
     end
 
     private

data/lib/sprig/reap/record.rb

@@ -16,7 +16,13 @@ module Sprig::Reap
 
     def to_hash
       attributes.reduce({"sprig_id" => sprig_id}) do |hash, attr|
-        hash.merge(attr => get_value_for(attr))
+        value = get_value_for(attr)
+
+        if Sprig::Reap.omit_empty_attrs && value.nil?
+          hash
+        else
+          hash.merge(attr => value)
+        end
       end
     end
 

data/lib/sprig/reap/seed_file.rb

@@ -1,5 +1,7 @@
 module Sprig::Reap
   class SeedFile
+    include Logging
+
     DEFAULT_NAMESPACE = 'records'
 
     attr_reader :model
@@ -21,6 +23,7 @@ module Sprig::Reap
     def write
       initialize_file do |file, namespace|
         file.write model.to_yaml(:namespace => namespace)
+        log_info "Successfully reaped records for #{model}...\r"
       end
     end
 
@@ -41,6 +44,9 @@ module Sprig::Reap
 
         yield file, namespace
       end
+
+    rescue
+      log_error "There was an issue writing to the file for #{model}...\r"
     end
 
     def existing_sprig_ids(yaml)

data/lib/sprig/reap/version.rb

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

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

@@ -127,7 +127,7 @@ describe Sprig::Reap::Configuration do
 
   describe "#ignored_attrs=" do
     context "when given nil" do
-      before { subject.classes = nil }
+      before { subject.ignored_attrs = nil }
 
       its(:ignored_attrs) { should == [] }
     end
@@ -144,4 +144,38 @@ describe Sprig::Reap::Configuration do
       its(:ignored_attrs) { should == ['shaka', 'laka'] }
     end
   end
+
+<<<<<<< HEAD
+  describe "#logger" do
+    it "initializes a new logger" do
+      Logger.should_receive(:new)
+
+      subject.logger
+=======
+  describe "#omit_empty_attrs" do
+    context "from a fresh configuration" do
+      its(:omit_empty_attrs) { should == false }
+    end
+  end
+
+  describe "#omit_empty_attrs" do
+    context "when given nil" do
+      before { subject.omit_empty_attrs = nil }
+
+      its(:omit_empty_attrs) { should == false }
+    end
+
+    context "when given a word other than true" do
+      before { subject.omit_empty_attrs = ' Shaboosh' }
+
+      its(:omit_empty_attrs) { should == false }
+    end
+
+    context "when given true" do
+      before { subject.omit_empty_attrs = 'True' }
+
+      its(:omit_empty_attrs) { should == true }
+>>>>>>> Add an option to allow users to omit empty attributes from seed files (fix #9)
+    end
+  end
 end

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

@@ -168,6 +168,42 @@ describe Sprig::Reap::Model do
         subject.to_yaml.should == yaml_from_file('polymorphic_vote_record.yml')
       end
     end
+
+    context "when there are no records for a given model" do
+      subject { described_class.new(Vote) }
+
+      its(:to_yaml) { should == nil }
+    end
+  end
+
+  describe "#records" do
+    let!(:post1) { Post.create }
+    let!(:post2) { Post.create }
+    let(:record) { double('Sprig::Reap::Record') }
+
+    subject { described_class.new(Post) }
+
+    before do
+      Sprig::Reap::Record.stub(:new).and_return(record)
+    end
+
+    its(:records) { should == [record, record] }
+
+    context "when there's an error accessing the database table for a given model" do
+      before do
+        Post.stub(:all).and_raise(StandardError)
+      end
+
+      it "logs an error message" do
+        log_should_receive :error, :with => "Encountered an error when pulling the database records for Post...\r"
+
+        subject.records
+      end
+
+      it "sets records to an empty array" do
+        subject.records.should == []
+      end
+    end
   end
 
   def yaml_from_file(basename)

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

@@ -100,9 +100,21 @@ describe Sprig::Reap::Record do
         }
       end
     end
-  end
 
-  describe "#local_file_for" do
+    context "when Sprig::Reap is configured to omit empty attributes" do
+      subject { described_class.new(posterless_post, model) }
+
+      before { Sprig::Reap.stub(:omit_empty_attrs).and_return(true) }
+
+      it "removes empty attributes from the resulting hash" do
+        subject.to_hash.should == {
+          'sprig_id'  => posterless_post.id,
+          'title'     => 'Wow Title',
+          'content'   => 'Much Content',
+          'published' => false
+        }
+      end
+    end
   end
 
   describe "#sprig_id" do

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

@@ -59,6 +59,12 @@ describe Sprig::Reap::SeedFile do
       setup_seed_folder('./spec/fixtures/db/seeds/dreamland', &example)
     end
 
+    it "logs the successful reap of database records for the given model" do
+      log_should_receive :info, :with => "Successfully reaped records for #{model}...\r"
+
+      subject.write
+    end
+
     context "when the seed file already exists" do
       before do
         yaml = File.read('./spec/fixtures/yaml/comment_seeds.yml')
@@ -125,5 +131,17 @@ describe Sprig::Reap::SeedFile do
         File.size?(subject.path).should > 0
       end
     end
+
+    context "when there are errors writing to the file" do
+      before do
+        File.stub(:open).and_raise(StandardError)
+      end
+
+      it "logs an error for the given model" do
+        log_should_receive :error, :with => "There was an issue writing to the file for Comment...\r"
+
+        subject.write
+      end
+    end
   end
 end

data/spec/lib/sprig/reap_spec.rb

@@ -18,6 +18,13 @@ describe Sprig::Reap do
       subject.clear_config
     end
 
+    it "outputs log messages when starting and on completion" do
+      log_should_receive :debug, :with => "Reaping records from the database...\r"
+      log_should_receive :debug, :with => "Finished reaping!"
+
+      subject.reap
+    end
+
     it "generates a seed file for each class" do
       count = Sprig::Reap.classes.count
 
@@ -73,6 +80,22 @@ describe Sprig::Reap do
         end
       end
     end
+
+    context "when passed a value for omitting empty attributes in the options hash" do
+      context "in :omit_empty_attrs" do
+        it "sets the flag to omit empty attributes" do
+          subject.reap(:omit_empty_attrs => true)
+          subject.omit_empty_attrs.should == true
+        end
+      end
+
+      context "in OMIT_EMPTY_ATTRS" do
+        it "sets the flag to omit empty attributes" do
+          subject.reap('OMIT_EMPTY_ATTRS' => ' TRUE ')
+          subject.omit_empty_attrs.should == true
+        end
+      end
+    end
   end
 
   describe ".clear_config" do

data/spec/spec_helper.rb

@@ -20,6 +20,8 @@ end
 RSpec.configure do |config|
   config.include RailsStubs
   config.include FileSetup
+  config.include LoggerMock
+  config.include ColoredText
 
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction

data/spec/support/colored_text.rb

@@ -0,0 +1,17 @@
+module ColoredText
+  def blue_text(text)
+    "\e[34m#{text}\e[0m"
+  end
+
+  def green_text(text)
+    "\e[32m#{text}\e[0m"
+  end
+
+  def orange_text(text)
+    "\e[33m#{text}\e[0m"
+  end
+
+  def red_text(text)
+    "\e[31m#{text}\e[0m"
+  end
+end

data/spec/support/logger_mock.rb

@@ -0,0 +1,21 @@
+module LoggerMock
+  def log_should_receive(level, options)
+    Sprig::Reap.logger.should_receive(level).with(send("log_#{level}_text", options.fetch(:with)))
+  end
+
+  def log_debug_text(text)
+    blue_text(text)
+  end
+
+  def log_info_text(text)
+    green_text(text)
+  end
+
+  def log_warn_text(text)
+    orange_text(text)
+  end
+
+  def log_error_text(text)
+    red_text(text)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprig-reap
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -134,6 +134,7 @@ files:
 - lib/sprig/reap/association.rb
 - lib/sprig/reap/configuration.rb
 - lib/sprig/reap/file_attribute.rb
+- lib/sprig/reap/logging.rb
 - lib/sprig/reap/model.rb
 - lib/sprig/reap/railtie.rb
 - lib/sprig/reap/record.rb
@@ -168,7 +169,9 @@ files:
 - spec/lib/sprig/reap_spec.rb
 - spec/lib/sprig_spec.rb
 - spec/spec_helper.rb
+- spec/support/colored_text.rb
 - spec/support/file_setup.rb
+- spec/support/logger_mock.rb
 - spec/support/matchers/be_same_file_as.rb
 - spec/support/rails_stubs.rb
 homepage: http://www.github.com/vigetlabs/sprig-reap
@@ -219,6 +222,8 @@ test_files:
 - spec/lib/sprig/reap_spec.rb
 - spec/lib/sprig_spec.rb
 - spec/spec_helper.rb
+- spec/support/colored_text.rb
 - spec/support/file_setup.rb
+- spec/support/logger_mock.rb
 - spec/support/matchers/be_same_file_as.rb
 - spec/support/rails_stubs.rb