sprig 0.1.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a11f717b26ca547b63e3a10d77e90e5fb0b34f99
-  data.tar.gz: 875a60cf93f12dda5e3cf04f17dca18c1201f53c
+SHA256:
+  metadata.gz: 467afaf41af6215b9da174e770e94265ae30774763a0b3f650086a56d15ecaea
+  data.tar.gz: 15ca2de82777633d207c659acef1bbd4aed1cfa0c4eb579a36ac8f74a12e9ae9
 SHA512:
-  metadata.gz: 3c5b80e9fbc98aeca33b2f535336a4ac577f4837ecc88b5315351f5cef5582bf67b6fad52a4af4b706c045bdb3120461c1c74b5e118eb177406f66a824e5cf99
-  data.tar.gz: 7660d42b5f0ca71849c63de2abaef6cc4ad324ee08598b00676b4196c80050eeb49264589258e601504ad5bac97514edfe42d5ec0624dbdb87193a903d0db875
+  metadata.gz: 29ffd4703a02baed76c2b6c4f1a1a30d56eed668e7bdf9ae4da07902e6271196e6f846ec734c0cd1aa6f24b52b4bf222b61bb9e62cd6a5a65933deed0d55fa7a
+  data.tar.gz: 69cb476a52cec76ca0752ef562dad5d5ee4c260367d7d4d62ae30e1adadf346d5adb69670142e4ce285a048c652bcd1acda934ebb00125aaeac77d8a702f9531

data/README.md

@@ -10,9 +10,13 @@ Learn more about Sprig and view documentation at [http://vigetlabs.github.io/spr
 
 ## Installation
 
-Use `rails generate sprig:install` to create environment-specific seed directories.
+Add into your Gemfile
+```ruby
+gem "sprig"
+```
+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.
 
@@ -22,18 +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.
 
@@ -47,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'
@@ -74,6 +90,8 @@ records:
 
 Each seed record needs a `sprig_id` defined that must be *unique across all seed files per class*.  It can be an integer, string, whatever you prefer; as long as it is unique, Sprig can sort your seeds for insertion and detect any cyclic relationships.
 
+### Relationships
+
 Create relationships between seed records with the `sprig_record` helper:
 
 ```yaml
@@ -85,6 +103,28 @@ records:
     body: "Yaml Comment body"
 ```
 
+#### Has and Belongs to Many
+For `has_and_belongs_to_many` (HABTM) relationships, you may define relation ids in array format. So if `Post` `has_and_belongs_to_many :tags`, you could write:
+```yaml
+#posts.yml
+
+records:
+  - sprig_id: 42
+    title: 'All About Brains'
+    content: 'Lorem ipsum...'
+    tag_ids:
+      - '<%= sprig_record(Tag, 1).id %>'
+      - '<%= sprig_record(Tag, 2).id %>'
+```
+```yaml
+#tags.yml
+
+records:
+  - sprig_id: 'bio'
+    name: 'Biology'
+  - 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`**
 
 ### Special Options
@@ -119,15 +159,17 @@ 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.
 
 ```ruby
+require 'open-uri'
+
 fanciness = {
   :class  => User,
   :source => open('https://spreadsheets.google.com/feeds/list/somerandomtoken/1/public/values?alt=json'),
-  :parser => Sprig::Data::Parser::GoogleSpreadsheetJson
+  :parser => Sprig::Parser::GoogleSpreadsheetJson
 }
 
 sprig [
@@ -137,23 +179,32 @@ 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
 ```
 
 ## Populate Seed Files from Database
 
 Want to create Sprig seed files from the records in your database? Well,
-[Sprig::Reap](http://www.rubygems.org/sprig-reap) can create them for you! Check out the gem's
+[Sprig::Reap](https://rubygems.org/gems/sprig-reap) can create them for you! Check out the gem's
 [README](https://github.com/vigetlabs/sprig-reap#sprigreap) for installation instructions and
 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,6 +19,27 @@ module Sprig
   autoload :Seed,                 'sprig/seed'
 
   class << self
+    attr_writer :adapter, :shared_seeding
+
+    def adapter
+      @adapter ||= :active_record
+    end
+
+    def adapter_model_class
+      @adapter_model_class ||= case adapter
+      when :active_record
+        ActiveRecord::Base
+      when :mongoid
+        Mongoid::Document
+      else
+        raise "Unknown model class for adapter #{adapter}"
+      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/directive.rb

@@ -7,7 +7,7 @@ module Sprig
         case
         when args.is_a?(Hash)
           args
-        when args.is_a?(Class) && args < ActiveRecord::Base
+        when args.is_a?(Class) && args < Sprig.adapter_model_class
           { :class => args }
         else
           raise ArgumentError, argument_error_message
@@ -30,8 +30,8 @@ module Sprig
     private
 
     def argument_error_message
-      'Sprig::Directive must be instantiated with an '\
-      'ActiveRecord subclass or a Hash with :class defined'
+      'Sprig::Directive must be instantiated with a(n) '\
+      "#{Sprig.adapter_model_class} class or a Hash with :class defined"
     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/planter.rb

@@ -25,7 +25,7 @@ module Sprig
     end
 
     def plant(seed)
-      notifier.in_progress
+      notifier.in_progress(seed)
       seed.before_save
 
       if seed.save_record

data/lib/sprig/process_notifier.rb

@@ -10,6 +10,10 @@ module Sprig
       @errors = []
     end
 
+    def in_progress(seed)
+      log_debug seed.in_progress_text
+    end
+
     def success(seed)
       log_info seed.success_log_text
       @success_count += 1
@@ -42,10 +46,6 @@ module Sprig
       end
     end
 
-    def in_progress
-      log_debug "Planting those seeds...\r"
-    end
-
     private
 
     def success_summary

data/lib/sprig/seed/attribute.rb

@@ -54,7 +54,7 @@ module Sprig
       end
 
       def computed_value_regex
-        /<%[=]?(.*)%>/
+        /(<%=?(.*?)%>)/
       end
 
       def compute_value(value)
@@ -73,9 +73,33 @@ module Sprig
         end
       end
 
+      def completely_dynamic_value?(string, matches)
+        return false if matches.count > 1
+
+        test_string = string.clone
+
+        matches.each do |match|
+          test_string = test_string.sub(match[0], "")
+        end
+
+        test_string.strip.length == 0
+      end
+
       def compute_string_value(string)
-        matches = computed_value_regex.match(string)
-        eval(matches[1])
+        matches = string.scan(computed_value_regex)
+
+        if completely_dynamic_value?(string, matches)
+          # If the dynamic portion is the entire value, return the result of the eval
+          # (This allows for the return of non-string types.)
+          eval(matches.first[1])
+        else
+          # Otherwise return the dynamic portion within the larger string.
+          string.clone.tap do |return_string|
+            matches.each do |match|
+              return_string.sub!(match[0], eval(match[1]).to_s)
+            end
+          end
+        end
       end
 
     end

data/lib/sprig/seed/entry.rb

@@ -34,12 +34,16 @@ module Sprig
         SprigRecordStore.instance.save(record.orm_record, sprig_id)
       end
 
-      def success_log_text
-        "#{klass.name} with sprig_id #{sprig_id} successfully #{success_log_status_text}."
+      def in_progress_text
+        "Planting #{klass.name} with sprig_id #{sprig_id}"
       end
 
-      def success_log_status_text
-        record.existing? ? "updated" : "saved"
+      def success_log_text
+        if record.existing?
+          "Updated"
+        else
+          "Saved"
+        end
       end
 
       def error_log_text

data/lib/sprig/seed/factory.rb

@@ -30,7 +30,7 @@ module Sprig
       def klass=(klass)
         raise ArgumentError, 'Must provide a Class as first argument' unless klass.is_a? Class
 
-        klass.reset_column_information
+        klass.reset_column_information if defined?(ActiveRecord) && klass < ActiveRecord::Base
         @klass = klass
       end
 

data/lib/sprig/source.rb

@@ -67,7 +67,7 @@ module Sprig
       end
 
       def file
-        File.new(seed_directory.join(filename))
+        File.new(filepath)
       end
 
       private
@@ -78,6 +78,15 @@ module Sprig
         available_files.detect {|name| name =~ /^#{table_name}\./ } || file_not_found
       end
 
+      def filepath
+        path = seed_directory.join(filename)
+        if File.symlink?(path)
+          File.readlink(path)
+        else
+          path
+        end
+      end
+
       def available_files
         Dir.entries(seed_directory)
       end

data/lib/sprig/version.rb

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