sprig 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8c76050cd88f10b7aa5734b205c1bdc5afbc5ea
-  data.tar.gz: ffeebeb96d52c7fa0cd0ba39c9c0fdf0d337c247
+  metadata.gz: 2a451bb75a9f2b2b04daafc72e40c2a92340d155
+  data.tar.gz: eb289195cee146a5b58709e215e2cc10e9c7916d
 SHA512:
-  metadata.gz: a35c299bee763d65c441323002da0b3f74405a2ecd9a831bfa5e108c033b3a3c129f151649e878293ea3f27d060265030054ec65ee0e252411fb86cffb3a6bb7
-  data.tar.gz: 99024ba29c6b31096a3a18332b31e1ba1594d062009cdba4731c592d39edc64b5bb4a1ceeff2632dbb2fd3bdf9d28b1adc9dc14912073b696cb5c89961a22a4d
+  metadata.gz: 3978471e61ded01e7372b921c996d20434c91e012cd1157be3c2e1c9e46de827478c33382289d5476fcff399d47ad63fca3a88b2274e38e687e7d8b128869820
+  data.tar.gz: 16d1051e32a5d2c090f501c517bc7b87a20975c82b72713937fd75a009f95d1cdbaed62722eac150cc404cdce9f1626ae17d0071b7d71bfa287cd00be78dd16a

data/README.md

@@ -14,9 +14,9 @@ Add into your Gemfile
 ```ruby
 gem "sprig"
 ```
-Use `rails generate sprig:install` to create environment-specific seed directories.
+Use `rails generate sprig:install` to create environment-specific and shared seed directories.
 
-##The Sprig Directive
+## The Sprig Directive
 
 Within your seed file, you can use the `sprig` directive to initiate Sprig's dark magicks. A simple directive might look like this.
 
@@ -26,17 +26,30 @@ Within your seed file, you can use the `sprig` directive to initiate Sprig's dar
 include Sprig::Helpers
 
 sprig [User, Post, Comment]
+
+For shared seeds:
+sprig_shared [User, Post, Comment]
 ```
 
 This directive tells Sprig to go find your datafiles for the `User`, `Post`, and `Comment` seed resources, build records from the data entries, and insert them into the database. Sprig will automatically detect known datafile types like `.yml`, `.json`, or `.csv` within your environment-specific seed directory.
 
-##Environment
+## Environment
 
 Seed files are unique to the environment in which your Rails application is running. Within `db/seeds` create an environment-specific directory (i.e. `/development` for your 'development' environment).
 
-Todo: [Support for shared seed files]
+### Shared
+
+Shared seed files default directory is `shared` (eg `db/seeds/shared`)
+You can change it by settings`
+
+To insert env specific together with shared seeds use:
+```ruby
+sprig [User]
+sprig_shared [User]
+```
+This will insert `:env/users` and `shared/users` seeds
 
-##Seed files
+## Seed files
 
 Hang your seed definitions on a `records` key for *yaml* and *json* files.
 
@@ -50,7 +63,7 @@ records:
     first_name: 'Lawson'
     last_name: 'Kurtz'
     username: 'lawdawg'
-  - sprig_id: 2
+  - sprig_id: 'ryan' # Note: Sprig IDs can be integers or strings
     first_name: 'Ryan'
     last_name: 'Foster'
     username: 'mc_rubs'
@@ -96,7 +109,7 @@ For `has_and_belongs_to_many` (HABTM) relationships, you may define relation ids
 #posts.yml
 
 records:
-  - sprig_id: 1
+  - sprig_id: 42
     title: 'All About Brains'
     content: 'Lorem ipsum...'
     tag_ids:
@@ -107,9 +120,9 @@ records:
 #tags.yml
 
 records:
-  - sprig_id: 1
+  - sprig_id: 'bio'
     name: 'Biology'
-  - sprig_id: 2
+  - sprig_id: 'neuro'
     name: 'Neuroscience'
 ```
 **Note: For namespaced or STI classes, you'll need to include the namespace with the class name in the seed file name. For example `Users::HeadManager` would need to be `users_head_managers.yml`**
@@ -146,7 +159,7 @@ records:
     published_at: "<%= 1.week.ago %>"
 ```
 
-##Custom Sources and Parsers
+## Custom Sources and Parsers
 
 If all your data is in `.wat` files, fear not. You can tell Sprig where to look for your data, and point it toward a custom parser class for turning your data into records. The example below tells Sprig to read `User` seed data from a Google Spreadsheet, and parse it accordingly.
 
@@ -166,13 +179,14 @@ sprig [
 ]
 ```
 
-##Configuration
+## Configuration
 
 When Sprig conventions don't suit, just add a configuration block to your seed file.
 
 ```ruby
 Sprig.configure do |c|
   c.directory = 'seed_files'
+  c.shared_directory = 'shared'
 end
 ```
 
@@ -186,3 +200,11 @@ details on usage.
 ## License
 
 This project rocks and uses MIT-LICENSE.
+
+***
+
+<a href="http://code.viget.com">
+  <img src="http://code.viget.com/github-banner.png" alt="Code At Viget">
+</a>
+
+Visit [code.viget.com](http://code.viget.com) to see more projects from [Viget.](https://viget.com)

data/lib/generators/sprig/install_generator.rb

@@ -9,12 +9,16 @@ module Sprig
 
       def create_enviroment_directories
         empty_directory 'db/seeds'
-
+        create_shared_directory
         envs.each { |env| empty_directory "db/seeds/#{env}" }
       end
 
       private
 
+      def create_shared_directory
+        empty_directory 'db/seeds/shared'
+      end
+
       def envs
         arg_envs ? arg_envs : default_envs
       end

data/lib/sprig.rb

@@ -19,7 +19,7 @@ module Sprig
   autoload :Seed,                 'sprig/seed'
 
   class << self
-    attr_writer :adapter
+    attr_writer :adapter, :shared_seeding
 
     def adapter
       @adapter ||= :active_record
@@ -36,6 +36,10 @@ module Sprig
       end
     end
 
+    def shared_seeding
+      @shared_seeding ||= false
+    end
+
     def configuration
       @@configuration ||= Sprig::Configuration.new
     end

data/lib/sprig/configuration.rb

@@ -1,10 +1,10 @@
 module Sprig
   class Configuration
 
-    attr_writer :directory, :logger
+    attr_writer :directory, :shared_directory, :logger
 
     def directory
-      Rails.root.join(@directory || default_directory, Rails.env)
+      Rails.root.join(@directory || default_directory, seeds_directory)
     end
 
     def logger
@@ -16,5 +16,22 @@ module Sprig
     def default_directory
       'db/seeds'
     end
+
+    def seeds_directory
+      return shared_seeds_directory if Sprig.shared_seeding
+      env_seeds_directory
+    end
+
+    def env_seeds_directory
+      Rails.env
+    end
+
+    def shared_seeds_directory
+      @shared_directory || default_shared_directory
+    end
+
+    def default_shared_directory
+      'shared'
+    end
   end
 end

data/lib/sprig/helpers.rb

@@ -5,9 +5,13 @@ module Sprig
     end
 
     def sprig(directive_definitions)
-      hopper = []
-      DirectiveList.new(directive_definitions).add_seeds_to_hopper(hopper)
-      Planter.new(hopper).sprig
+      Sprig.shared_seeding = false
+      plant_records(directive_definitions)
+    end
+
+    def sprig_shared(directive_definitions)
+      Sprig.shared_seeding = true
+      plant_records(directive_definitions)
     end
 
     def sprig_record(klass, seed_id)
@@ -19,5 +23,13 @@ module Sprig
     def sprig_file(relative_path)
       File.new(seed_directory.join('files', relative_path))
     end
+
+    private
+
+    def plant_records(directive_definitions)
+      hopper = []
+      DirectiveList.new(directive_definitions).add_seeds_to_hopper(hopper)
+      Planter.new(hopper).sprig
+    end
   end
 end

data/lib/sprig/version.rb

@@ -1,3 +1,10 @@
 module Sprig
-  VERSION = "0.2.0"
+
+  #:nocov:
+  VERSION = [
+    0, # major
+    3, # minor
+    0  # patch
+  ].join('.')
+  #:nocov:
 end

data/spec/feature/configurations_spec.rb

@@ -1,19 +1,19 @@
 require 'spec_helper'
 
-describe "Configurating Sprig" do
+RSpec.describe "Configurating Sprig" do
   before do
     stub_rails_root '~'
     stub_rails_env 'development'
   end
 
   it "can set the directory" do
-    Sprig.configuration.directory.to_path.should == '~/db/seeds/development'
+    expect(Sprig.configuration.directory.to_path).to eq('~/db/seeds/development')
 
     Sprig.configure do |c|
       c.directory = 'seed_files'
     end
 
-    Sprig.configuration.directory.to_path.should == '~/seed_files/development'
+    expect(Sprig.configuration.directory.to_path).to eq('~/seed_files/development')
   end
 
   it "can reset the configuration" do
@@ -21,10 +21,10 @@ describe "Configurating Sprig" do
       c.directory = 'seed_files'
     end
 
-    Sprig.configuration.directory.to_path.should == '~/seed_files/development'
+    expect(Sprig.configuration.directory.to_path).to eq('~/seed_files/development')
 
     Sprig.reset_configuration
 
-    Sprig.configuration.directory.to_path.should == '~/db/seeds/development'
+    expect(Sprig.configuration.directory.to_path).to eq('~/db/seeds/development')
   end
 end

data/spec/fixtures/seeds/shared/comments.yml

@@ -0,0 +1,4 @@
+records:
+  - sprig_id: 1
+    post_id: "<%= sprig_record(Post, 1).id %>"
+    body: "Yaml Comment body"

data/spec/fixtures/seeds/shared/invalid_users.yml

@@ -0,0 +1,4 @@
+records:
+  - sprig_id: 1
+    first_name: "Clark"
+    # intentionally leaving out last_name so record fails to create

data/spec/fixtures/seeds/shared/legacy_posts.yml

@@ -0,0 +1,4 @@
+records:
+  - sprig_id: 'l_1'
+    title: 'Legacy yaml title'
+    content: 'Legacy yaml content'

data/spec/fixtures/seeds/shared/posts.csv

@@ -0,0 +1,2 @@
+sprig_id,title,content
+1,Csv title,Csv content

data/spec/fixtures/seeds/shared/posts.json

@@ -0,0 +1 @@
+{"records":[{"sprig_id":1,"title":"Json title","content":"Json content"}]}

data/spec/fixtures/seeds/shared/posts.md

@@ -0,0 +1,5 @@
+# Posts
+
+- Post 1
+- Post 2
+- Post 3

data/spec/fixtures/seeds/shared/posts.yml

@@ -0,0 +1,4 @@
+records:
+  - sprig_id: 1
+    title: 'Yaml title'
+    content: 'Yaml content'

data/spec/fixtures/seeds/shared/posts_delete_existing_by.yml

@@ -0,0 +1,7 @@
+options:
+  delete_existing_by: 'title'
+
+records:
+  - sprig_id: 1
+    title: 'Such Title'
+    content: 'New content'

data/spec/fixtures/seeds/shared/posts_find_existing_by_missing.yml

@@ -0,0 +1,7 @@
+options:
+  find_existing_by: 'unicorn'
+
+records:
+  - sprig_id: 1
+    title: 'Existing title'
+    content: 'Updated content'

data/spec/fixtures/seeds/shared/posts_find_existing_by_multiple.yml

@@ -0,0 +1,8 @@
+options:
+  find_existing_by: ['title', 'content']
+
+records:
+  - sprig_id: 1
+    title: 'Existing title'
+    content: 'Existing content'
+    published: true

data/spec/fixtures/seeds/shared/posts_find_existing_by_single.yml

@@ -0,0 +1,7 @@
+options:
+  find_existing_by: 'title'
+
+records:
+  - sprig_id: 1
+    title: 'Existing title'
+    content: 'Updated content'

data/spec/fixtures/seeds/shared/posts_missing_dependency.yml

@@ -0,0 +1,5 @@
+records:
+  - sprig_id: 1
+    title: 'Yaml title'
+    content: 'Yaml content'
+    comment_id: "<%= sprig_record(Comment, 42).id %>" # This sprig record does not exist.

data/spec/fixtures/seeds/shared/posts_missing_record.yml

@@ -0,0 +1,5 @@
+records:
+  - sprig_id: 1
+    title: 'Yaml title'
+    content: 'Yaml content'
+    user_id: "<%= sprig_record(User, 1).id %>" # This sprig record did not save.

data/spec/fixtures/seeds/shared/posts_partially_dynamic_value.yml

@@ -0,0 +1,4 @@
+records:
+  - sprig_id: 1
+    title: '<%= "Partially" %> <%= "Dynamic" %> Title'
+    content: 'Yaml content'

data/spec/fixtures/seeds/shared/posts_with_cyclic_dependencies.yml

@@ -0,0 +1,4 @@
+records:
+  - sprig_id: 1
+    title: "Title"
+    content: "<%= sprig_record(Comment, 1) %>"

data/spec/fixtures/seeds/shared/posts_with_files.yml

@@ -0,0 +1,5 @@
+records:
+  - sprig_id: 1
+    title: 'Staging yaml title'
+    content: 'Staging yaml content'
+    photo: '<%= sprig_file("cat.png") %>'

data/spec/fixtures/seeds/shared/posts_with_habtm.yml

@@ -0,0 +1,7 @@
+records:
+  - sprig_id: 1
+    title: 'Yaml title'
+    content: 'Yaml content'
+    tag_ids:
+      - '<%= sprig_record(Tag, 1).id %>'
+      - '<%= sprig_record(Tag, 2).id %>'

data/spec/fixtures/seeds/shared/tags.yml

@@ -0,0 +1,5 @@
+records:
+  - sprig_id: 1
+    name: 'Botany'
+  - sprig_id: 2
+    name: 'Biology'

data/spec/lib/generators/sprig/install_generator_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'generators/sprig/install_generator'
 
-describe Sprig::Generators::InstallGenerator, type: :generator do
+RSpec.describe Sprig::Generators::InstallGenerator, type: :generator do
   destination File.expand_path("../../tmp", __FILE__)
 
   before do
@@ -14,6 +14,10 @@ describe Sprig::Generators::InstallGenerator, type: :generator do
     assert_directory "db/seeds"
   end
 
+  it "creates empty shared directory" do
+    assert_directory "db/seeds/shared"
+  end
+
   it "creates empty seed environment directories" do
     [
       :development,
@@ -29,7 +33,7 @@ end
 # Generator arguments are set on a class basis. We need to open
 # a new describe block to make these examples work.
 
-describe Sprig::Generators::InstallGenerator, type: :generator do
+RSpec.describe Sprig::Generators::InstallGenerator, type: :generator do
   context "with arguments" do
     destination File.expand_path("../../tmp", __FILE__)
     arguments %w(development test integration)

data/spec/lib/sprig/configuration_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Sprig::Configuration do
+RSpec.describe Sprig::Configuration do
   before do
     stub_rails_root '~'
     stub_rails_env 'development'
@@ -8,29 +8,29 @@ describe Sprig::Configuration do
 
   describe "#directory" do
     it "returns db/seeds/:env by default" do
-      subject.directory.to_path.should == '~/db/seeds/development'
+      expect(subject.directory.to_path).to eq('~/db/seeds/development')
     end
 
     it "returns a custom directory" do
       subject.directory = 'seed_files'
 
-      subject.directory.to_path.should == '~/seed_files/development'
+      expect(subject.directory.to_path).to eq('~/seed_files/development')
     end
   end
 
   describe "#logger" do
     it "returns an stdout logger by default" do
       logger = double('Logger')
-      Logger.stub(:new).with($stdout).and_return(logger)
+      allow(Logger).to receive(:new).with($stdout).and_return(logger)
 
-      subject.logger.should == logger
+      expect(subject.logger).to eq(logger)
     end
 
     it "returns a custom logger" do
       logger = double('Logger')
       subject.logger = logger
 
-      subject.logger.should == logger
+      expect(subject.logger).to eq(logger)
     end
   end
 end