sprig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 391a106a3a06f570e669016d9625f92c62feb152
+  data.tar.gz: d8ffa472a8d094540db22d9016eff0ef685c8755
+SHA512:
+  metadata.gz: 489f198c7432cab1d2474eec6939e1e67f4ef9ebdb43f3faa2c93fe96263b43797dd8372c360a8f65a7d23c724a4b806ea44335cc3923b45c16222a17edacfde
+  data.tar.gz: a15a56f4af8df7492fa7ac2212223c59314163620d28e0301dbbe55f66418dabebd2139e78fcf9b289566c62dc8ab9c0fc58afc7be9d2cdb07125a445a49de62

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Viget
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+#Sprig
+
+[![Code Climate](https://codeclimate.com/github/vigetlabs/sprig.png)](https://codeclimate.com/github/vigetlabs/sprig) [![Build Status](https://travis-ci.org/vigetlabs/sprig.png?branch=master)](https://travis-ci.org/vigetlabs/sprig)
+
+Seed Rails application by convention, not configuration.
+
+Provides support for common files types: *csv*, *yaml*, and *json*.  Extensible for the rest!
+
+
+##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.
+
+```ruby
+# seeds.rb
+
+include Sprig::Helpers
+
+sprig [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
+
+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]
+
+
+##Seed files
+
+Hang your seed definitions on a `records` key for *yaml* and *json* files.
+
+Examples:
+
+```yaml
+# users.yml
+
+records:
+  - sprig_id: 1
+    first_name: 'Lawson'
+    last_name: 'Kurtz'
+    username: 'lawdawg'
+  - sprig_id: 2
+    first_name: 'Ryan'
+    last_name: 'Foster'
+    username: 'mc_rubs'
+```
+
+```json
+// posts.json
+
+{
+  "records":[
+    {
+      "sprig_id":1,
+      "title":"Json title",
+      "content":"Json content"
+    },
+    {
+      "sprig_id":2,
+      "title":"Headline",
+      "content":"Words about things"
+    }
+  ]
+}
+```
+
+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.
+
+Create relationships between seed records with the `sprig_record` helper:
+
+```yaml
+# comments.yml
+
+records:
+  - sprig_id: 1
+    post_id: "<%= sprig_record(Post, 1).id %>"
+    body: "Yaml Comment body"
+```
+
+### Special Options
+
+These are provided in a `options:` key for *yaml* and *json* files.
+
+#### find_existing_by:
+
+Rather than starting from a blank database, you can optionally choose to find existing records and update them with seed data.
+
+The passed in attribute or array of attributes will be used for finding existing records during the sprigging process.
+
+Example:
+
+```yaml
+# posts.yml
+
+options:
+  find_existing_by: ['title', 'user_id']
+```
+
+##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
+fanciness = {
+  :class  => User,
+  :source => open('https://spreadsheets.google.com/feeds/list/somerandomtoken/1/public/values?alt=json'),
+  :parser => Sprig::Data::Parser::GoogleSpreadsheetJson
+}
+
+sprig [
+  fanciness,
+  Post,
+  Comment
+]
+```
+
+##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'
+end
+```
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sprig.rb

@@ -0,0 +1,29 @@
+module Sprig
+  autoload :Configuration,        'sprig/configuration'
+  autoload :Planter,              'sprig/planter'
+  autoload :Dependency,           'sprig/dependency'
+  autoload :DependencyCollection, 'sprig/dependency_collection'
+  autoload :DependencySorter,     'sprig/dependency_sorter'
+  autoload :Directive,            'sprig/directive'
+  autoload :DirectiveList,        'sprig/directive_list'
+  autoload :Source,               'sprig/source'
+  autoload :Parser,               'sprig/parser'
+  autoload :Helpers,              'sprig/helpers'
+  autoload :Planter,              'sprig/planter'
+  autoload :SprigLogger,            'sprig/sprig_logger'
+  autoload :SprigRecordStore,      'sprig/sprig_record_store'
+  autoload :Data,                 'sprig/data'
+  autoload :Seed,                 'sprig/seed'
+
+  def self.configuration
+    @@configuration ||= Sprig::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.reset_configuration
+    @@configuration = nil
+  end
+end

data/lib/sprig/configuration.rb

@@ -0,0 +1,16 @@
+module Sprig
+  class Configuration
+
+    attr_writer :directory
+
+    def directory
+      Rails.root.join(@directory || default_directory, Rails.env)
+    end
+
+    private
+
+    def default_directory
+      'db/seeds'
+    end
+  end
+end

data/lib/sprig/data.rb

@@ -0,0 +1,6 @@
+module Sprig
+  module Data
+    autoload :Source, 'sprig/data/source'
+    autoload :Parser, 'sprig/data/parser'
+  end
+end

data/lib/sprig/dependency.rb

@@ -0,0 +1,45 @@
+module Sprig
+  class Dependency
+    attr_reader :id
+
+    def self.for(klass, sprig_id)
+      klass = to_klass(klass)
+      sprig_id = sprig_id.to_s
+
+      collection.get(klass, sprig_id) || new(klass, sprig_id)
+    end
+
+    def initialize(klass, sprig_id)
+      @klass = klass
+      @sprig_id = sprig_id
+      @id = SecureRandom.uuid
+
+      self.class.collection.set(klass, sprig_id, self)
+    end
+
+    def sprig_record_reference
+      "sprig_record(#{klass}, #{sprig_id})"
+    end
+
+    private
+
+    attr_reader :klass, :sprig_id
+
+    def self.to_klass(klass)
+      if klass.is_a?(String)
+        klass = klass.classify.constantize
+      end
+
+      raise ArgumentError, 'First argument must be a Class.' unless klass.is_a?(Class)
+
+      klass
+    rescue NameError => e
+      raise NameError, e.message
+      #TODO: rescue bad class references
+    end
+
+    def self.collection
+      @@collection ||= DependencyCollection.new
+    end
+  end
+end

data/lib/sprig/dependency_collection.rb

@@ -0,0 +1,23 @@
+module Sprig
+  class DependencyCollection
+    def initialize
+      @records = {}
+    end
+
+    def get(klass, id)
+      records_for_klass(klass)[id]
+    end
+
+    def set(klass, id, value)
+      records_for_klass(klass)[id] = value
+    end
+
+    private
+
+    attr_reader :records
+
+    def records_for_klass(klass)
+      records[klass] ||= {}
+    end
+  end
+end

data/lib/sprig/dependency_sorter.rb

@@ -0,0 +1,83 @@
+module Sprig
+  class DependencySorter
+    class CircularDependencyError < StandardError; end
+
+    attr_reader :items
+
+    def initialize(items)
+      @items = items.to_a
+    end
+
+    def sorted_items
+      sorted_tags.map do |tag|
+        id_dictionary[tag]
+      end
+    end
+
+    private
+
+    def id_dictionary
+      @id_dictionary ||= begin
+        {}.tap do |hash|
+          items.each do |item|
+            hash[item.dependency_id] = item
+          end
+        end
+      end
+    end
+
+    def dependency_hash
+      @dependency_hash ||= begin
+        TsortableHash.new.tap do |hash|
+          items.each do |item|
+            hash[item.dependency_id] = item.dependencies.map(&:id)
+          end
+        end
+      end
+    end
+
+    def sorted_tags
+      dependency_hash.tsort
+    rescue TSort::Cyclic => e
+      raise CircularDependencyError.new("Your sprig directives contain circular dependencies. #{e.message}")
+    rescue KeyError => key_error
+      raise missing_dependency_error_from_key_error(key_error)
+    end
+
+    def dependencies
+      items.map(&:dependencies).flatten
+    end
+
+    def missing_dependency_error_from_key_error(key_error)
+      key = key_error.message.match(/\Akey not found: "(.*)"\Z/)[1]
+      missing_dependency = dependencies.detect { |item| item.id == key }
+      MissingDependencyError.new(missing_dependency)
+    end
+
+    class TsortableHash < Hash
+      include TSort
+
+      alias tsort_each_node each_key
+
+      def tsort_each_child(node, &block)
+        fetch(node).each(&block)
+      end
+    end
+
+    class MissingDependencyError < StandardError
+      def initialize(missing_dependency = nil)
+        super message_for(missing_dependency)
+      end
+
+      private
+
+      def message_for(missing_dependency)
+        if missing_dependency.is_a? Dependency
+          "Undefined reference to '#{missing_dependency.sprig_record_reference}'"
+        else
+          "Referenced 'sprig_record' does not have a correlating record."
+        end
+      end
+    end
+  end
+end

data/lib/sprig/directive.rb

@@ -0,0 +1,37 @@
+module Sprig
+  class Directive
+    attr_reader :attributes
+
+    def initialize(args)
+      @attributes = begin
+        case
+        when args.is_a?(Hash)
+          args
+        when args < ActiveRecord::Base
+          { :class => args }
+        else
+          raise ArgumentError, argument_error_message
+        end
+      end
+    end
+
+    def klass
+      @klass ||= attributes.fetch(:class) { raise ArgumentError, argument_error_message }
+    end
+
+    def options
+      @options ||= attributes.except(:class)
+    end
+
+    def datasource
+      @datasource ||= Source.new(klass.to_s.tableize, options)
+    end
+
+    private
+
+    def argument_error_message
+      'Sprig::Directive must be instantiated with an '\
+      'ActiveRecord subclass or a Hash with :class defined'
+    end
+  end
+end

data/lib/sprig/directive_list.rb

@@ -0,0 +1,30 @@
+module Sprig
+  class DirectiveList
+
+    def initialize(definitions)
+      @definitions = Array(definitions)
+    end
+
+    def add_seeds_to_hopper(hopper)
+      seed_factories.each do |factory|
+        factory.add_seeds_to_hopper(hopper)
+      end
+    end
+
+    private
+
+    attr_reader :definitions
+
+    def directives
+      @directives ||= definitions.map do |definition|
+        Directive.new(definition)
+      end
+    end
+
+    def seed_factories
+      directives.map do |directive|
+        Seed::Factory.new_from_directive(directive)
+      end
+    end
+  end
+end