sprig-reap 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9274dc514b03b7804de43aba385e8cc68d954af
-  data.tar.gz: f9c7b62a38c72b9745ef5a982b7ae26fc43ced61
+  metadata.gz: aefd592ca49ff880defe79c87d202f9309d19155
+  data.tar.gz: 87c0a8f35ae8fc00915194443bc6e63d6d2b41f0
 SHA512:
-  metadata.gz: d0f68d527c8ae07b07a1fb7b6e3f2874343f3b62f4f340383a2dd90c354914d13a821ce2898c6cc364cf8b3b7b4e805b208104465198498cb5e3ee97b750ef6c
-  data.tar.gz: 50f0b95641ecf1de92a336f302b6bd33657e7f7f15db17527ef888aaf7fd28f031a8d63ca60bbea01ae37fbf8eb7a3f33c2e1eb319bc454f1ba589fdfbe8a6a1
+  metadata.gz: a8f4110f827135c3674aff16b1b621db501bbd945c20619ec109ce2ccd3c3692462731e027961a578bd14e8309ae2db0059b189bc154f719bbb7cfe8b31022f3
+  data.tar.gz: 5dfb7babbff4b81964232a81110ad19a0f52b231ad1b69d3914f469f9d82e33a23f70920b6a4b65b94755389559eb953fd54150e97b0f94c26fe92f9dd0074d2

data/README.md

@@ -1,10 +1,21 @@
 # Sprig::Reap
 
-Automatic capture and output of your application's data state to Sprig-formatted seed files.
+[![Code Climate](https://codeclimate.com/github/vigetlabs/sprig-reap.png)](https://codeclimate.com/github/vigetlabs/sprig-reap) [![Build Status](https://travis-ci.org/vigetlabs/sprig-reap.png?branch=master)](https://travis-ci.org/vigetlabs/sprig-reap) [![Gem Version](https://badge.fury.io/rb/sprig-reap.png)](http://badge.fury.io/rb/sprig-reap)
 
-## Populate Seed Files from Database
+Don't want to write Sprig seed files from scratch?  No problem!  Sprig::Reap can create them for
+you.  Sprig::Reap enables automatic capture and output of your application's data state to
+Sprig-formatted seed files.
 
-Don't want to write Sprig seed files from scratch?  Well, Sprig::Reap can create them for you!
+## Installation
+```
+# Command Line
+gem install sprig-reap
+
+# Gemfile
+gem 'sprig-reap'
+```
+
+## Usage
 
 Via a rake task:
 ```
@@ -24,15 +35,17 @@ 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 environment (`db/seeds`
-target folder) or models (`ActiveRecord::Base.subclasses`-only) you want seed files for.
+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.
 
 ```
 # Rake Task
-rake db:seed:reap ENV=integration MODELS=User,Post
+rake db:seed:reap TARGET_ENV=integration MODELS=User,Post IGNORED_ATTRS=created_at,updated_at
 
 # Rails Console
-Sprig::Reap.reap(env: 'integration', models: [User, Post])
+Sprig::Reap.reap(target_env: 'integration', models: [User, Post], ignored_attrs: [:created_at,
+:updated_at])
 ```
 
 ### Adding to Existing Seed Files (`.yaml` only)

data/lib/sprig/reap/configuration.rb

@@ -2,13 +2,13 @@ module Sprig::Reap
   class Configuration
     VALID_CLASSES = ActiveRecord::Base.subclasses
 
-    def env
-      @env ||= Rails.env
+    def target_env
+      @target_env ||= Rails.env
     end
 
-    def env=(given_env)
-      parse_valid_env_from given_env do |environment|
-        @env = environment
+    def target_env=(given_env)
+      parse_valid_env_from given_env do |target_environment|
+        @target_env = target_environment
       end
     end
 
@@ -22,17 +22,25 @@ module Sprig::Reap
       end
     end
 
+    def ignored_attrs
+      @ignored_attrs ||= []
+    end
+
+    def ignored_attrs=(input)
+      @ignored_attrs = parse_ignored_attrs_from(input)
+    end
+
     private
 
     def parse_valid_env_from(input)
       return if input.nil?
-      environment = input.strip.downcase
-      create_seeds_folder(environment)
-      yield environment
+      target_environment = input.strip.downcase
+      create_seeds_folder(target_environment)
+      yield target_environment
     end
 
-    def create_seeds_folder(env)
-      folder = Rails.root.join('db', 'seeds', env)
+    def create_seeds_folder(target_env)
+      folder = Rails.root.join('db', 'seeds', target_env)
       FileUtils.mkdir_p(folder) unless File.directory? folder
     end
 
@@ -57,5 +65,15 @@ module Sprig::Reap
         end
       end
     end
+
+    def parse_ignored_attrs_from(input)
+      return if input.nil?
+
+      if input.is_a? String
+        input.split(',').map(&:strip)
+      else
+        input.map(&:to_s).map(&:strip)
+      end
+    end
   end
 end

data/lib/sprig/reap/model.rb

@@ -22,7 +22,7 @@ module Sprig::Reap
     end
 
     def attributes
-      klass.column_names
+      klass.column_names - Sprig::Reap.ignored_attrs
     end
 
     def dependencies

data/lib/sprig/reap/seed_file.rb

@@ -11,7 +11,7 @@ module Sprig::Reap
     end
 
     def path
-      Rails.root.join('db', 'seeds', Sprig::Reap.env, "#{model.to_s.tableize.gsub('/', '_')}.yml")
+      Rails.root.join('db', 'seeds', Sprig::Reap.target_env, "#{model.to_s.tableize.gsub('/', '_')}.yml")
     end
 
     def exists?

data/lib/sprig/reap/version.rb

@@ -1,5 +1,5 @@
 module Sprig
   module Reap
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/sprig/reap.rb

@@ -11,8 +11,9 @@ module Sprig::Reap
   class << self
     def reap(options = {})
       configure do |config|
-        config.env     = options[:env]    || options['ENV']
-        config.classes = options[:models] || options['MODELS']
+        config.target_env    = options[:target_env]    || options['TARGET_ENV']
+        config.classes       = options[:models]        || options['MODELS']
+        config.ignored_attrs = options[:ignored_attrs] || options['IGNORED_ATTRS']
       end
 
       Model.all.each { |model| SeedFile.new(model).write }
@@ -22,7 +23,10 @@ module Sprig::Reap
 
     cattr_reader :configuration
 
-    delegate :env, :classes, to: :configuration
+    delegate :target_env,
+             :classes,
+             :ignored_attrs,
+             to: :configuration
 
     def configuration
       @@configuration ||= Configuration.new

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

@@ -7,28 +7,28 @@ describe Sprig::Reap::Configuration do
     stub_rails_root
   end
 
-  describe "#env" do
+  describe "#target_env" do
     context "from a fresh configuration" do
-      its(:env) { should == Rails.env }
+      its(:target_env) { should == Rails.env }
     end
   end
 
-  describe "#env=" do
+  describe "#target_env=" do
     context "when given nil" do
-      it "does not change the env" do
-        subject.env = nil
+      it "does not change the target_env" do
+        subject.target_env = nil
 
-        subject.env.should_not == nil
+        subject.target_env.should_not == nil
       end
     end
 
     context "given a non-nil value" do
       let(:input) { ' ShaBOOSH' }
 
-      it "formats the given value and then sets the environment" do
-        subject.env = input
+      it "formats the given value and then sets the target environment" do
+        subject.target_env = input
 
-        subject.env.should == 'shaboosh'
+        subject.target_env.should == 'shaboosh'
       end
 
       context "and the corresponding seeds folder does not yet exist" do
@@ -37,7 +37,7 @@ describe Sprig::Reap::Configuration do
         end
 
         it "creates the seeds folder" do
-          subject.env = input
+          subject.target_env = input
 
           File.directory?('./spec/fixtures/db/seeds/shaboosh').should == true
         end
@@ -96,4 +96,30 @@ describe Sprig::Reap::Configuration do
       end
     end
   end
+
+  describe "#ignored_attrs" do
+    context "from a fresh configuration" do
+      its(:ignored_attrs) { should == [] }
+    end
+  end
+
+  describe "#ignored_attrs=" do
+    context "when given nil" do
+      before { subject.classes = nil }
+
+      its(:ignored_attrs) { should == [] }
+    end
+
+    context "when given an array of ignored_attrs" do
+      before { subject.ignored_attrs = [:shaka, ' laka '] }
+
+      its(:ignored_attrs) { should == ['shaka', 'laka'] }
+    end
+
+    context "when given a string" do
+      before { subject.ignored_attrs = ' shaka, laka' }
+
+      its(:ignored_attrs) { should == ['shaka', 'laka'] }
+    end
+  end
 end

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

@@ -39,9 +39,25 @@ describe Sprig::Reap::Model do
   end
 
   describe "#attributes" do
+    let(:attrs) { %w(boom shaka laka) }
+
     subject { described_class.new(User) }
 
-    its(:attributes) { should == User.column_names }
+    before do
+      User.stub(:column_names).and_return(attrs)
+    end
+
+    context "when there are no ignored attributes" do
+      its(:attributes) { should == attrs }
+    end
+
+    context "when there are ignored attributes" do
+      before do
+        Sprig::Reap.stub(:ignored_attrs).and_return(['laka'])
+      end
+
+      its(:attributes) { should == ['boom', 'shaka'] }
+    end
   end
 
   describe "#dependencies" do

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

@@ -7,7 +7,7 @@ describe Sprig::Reap::SeedFile do
 
   before do
     stub_rails_root
-    Sprig::Reap.stub(:env).and_return('dreamland')
+    Sprig::Reap.stub(:target_env).and_return('dreamland')
   end
 
   describe "#initialize" do

data/spec/lib/sprig/reap_spec.rb

@@ -21,17 +21,17 @@ describe Sprig::Reap do
     end
 
     context "when passed an environment in the options hash" do
-      context "in :env" do
+      context "in :target_env" do
         it "sets the environment" do
-          subject.reap(:env => 'dreamland')
-          subject.env.should == 'dreamland'
+          subject.reap(:target_env => 'dreamland')
+          subject.target_env.should == 'dreamland'
         end
       end
 
-      context "in 'ENV'" do
+      context "in 'TARGET_ENV'" do
         it "sets the environment" do
           subject.reap('ENV' => ' Dreamland')
-          subject.env.should == 'dreamland'
+          subject.target_env.should == 'dreamland'
         end
       end
     end
@@ -51,5 +51,21 @@ describe Sprig::Reap do
         end
       end
     end
+
+    context "when passed a list of ignored attributes in the options hash" do
+      context "in :ignored_attrs" do
+        it "sets ignored attributes" do
+          subject.reap(:ignored_attrs => [:willy, :nilly])
+          subject.ignored_attrs.should == ['willy', 'nilly']
+        end
+      end
+
+      context "in IGNORED_ATTRS" do
+        it "sets ignored attributes" do
+          subject.reap('IGNORED_ATTRS' => ' willy, nilly')
+          subject.ignored_attrs.should == ['willy', 'nilly']
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprig-reap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Stenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails