sprig 0.1.0

data/lib/sprig/source.rb

@@ -0,0 +1,143 @@
+module Sprig
+  class Source
+
+    def initialize(table_name, args = {})
+      @table_name = table_name
+      @args       = args
+    end
+
+    def records
+      data[:records] || []
+    end
+
+    def options
+      data[:options] || {}
+    end
+
+    private
+
+    attr_reader :table_name, :args
+
+    def data
+      @data ||= begin
+        parser_class.new(source).parse.to_hash.with_indifferent_access
+      ensure
+        source.close
+      end
+    end
+
+    def source
+      @source ||= begin
+        source = args.fetch(:source) { default_source }
+
+        unless source.respond_to?(:read) && source.respond_to?(:close)
+          raise ArgumentError, 'Data sources must act like an IO.'
+        end
+
+        source
+      end
+    end
+
+    def parser_class
+      @parser_class ||= begin
+        parser_class = args.fetch(:parser) { default_parser_class }
+
+        unless parser_class.method_defined?(:parse)
+          raise ArgumentError, 'Parsers must define #parse.'
+        end
+
+        parser_class
+      end
+    end
+
+    def default_source
+      File.open(SourceDeterminer.new(table_name).file)
+    end
+
+    def default_parser_class
+      ParserDeterminer.new(source).parser
+    end
+
+
+    class SourceDeterminer
+      attr_reader :table_name
+
+      def initialize(table_name)
+        @table_name = table_name
+      end
+
+      def file
+        File.new(seed_directory.join(filename))
+      end
+
+      private
+
+      class FileNotFoundError < StandardError; end
+
+      def filename
+        available_files.detect {|name| name =~ /^#{table_name}\./ } || file_not_found
+      end
+
+      def available_files
+        Dir.entries(seed_directory)
+      end
+
+      def file_not_found
+        raise FileNotFoundError,
+          "No datasource file could be found for '#{table_name}'. Try creating "\
+          "#{table_name}.yml, #{table_name}.json, or #{table_name}.csv within "\
+          "#{seed_directory}, or define a custom datasource."
+      end
+    end
+
+
+    class ParserDeterminer
+
+      def initialize(file)
+        @file = file
+      end
+
+      def parser
+        match = parser_matchers.detect {|p| p[:extension] =~ extension } || unparsable_file
+        match[:parser]
+      end
+
+      private
+
+      class UnparsableFileError < StandardError; end
+
+      attr_reader :file
+
+      def extension
+        File.extname(file)
+      end
+
+      def parser_matchers
+        [
+          {
+            extension: /\.y(a)?ml/i,
+            parser: Sprig::Parser::Yml
+          },
+          {
+            extension: /\.json/i,
+            parser: Sprig::Parser::Json
+          },
+          {
+            extension: /\.csv/i,
+            parser: Sprig::Parser::Csv
+          }
+        ]
+      end
+
+      def parsable_formats
+        ['YAML', 'JSON', 'CSV']
+      end
+
+      def unparsable_file
+        raise UnparsableFileError,
+          "No parser was found for the file '#{file}'. Provide a custom parser, or "\
+          "use a supported data format (#{parsable_formats})."
+      end
+    end
+  end
+end

data/lib/sprig/sprig_logger.rb

@@ -0,0 +1,68 @@
+require 'active_support/inflector'
+
+module Sprig
+  class SprigLogger
+    def initialize
+      @success_count = 0
+      @error_count = 0
+      @errors = []
+    end
+
+    def log_success(seed)
+      message = seed.success_log_text
+      puts green(message)
+      @success_count += 1
+    end
+
+    def log_error(seed)
+      message = seed.error_log_text
+      @errors << seed.record
+      puts red(message)
+      @error_count += 1
+    end
+
+    def log_summary
+      puts 'Seeding complete.'
+
+      if @success_count > 0
+        puts green(success_summary)
+      else
+        puts red(success_summary)
+      end
+
+      if @error_count > 0
+        puts red(error_summary)
+
+        @errors.each do |error|
+          puts red("#{error}\n#{error.errors.messages}\n\n")
+        end
+      end
+    end
+
+    def processing
+      print "Planting those seeds...\r"
+    end
+
+    private
+
+    def colorize(message, color_code)
+      "\e[#{color_code}m#{message}\e[0m"
+    end
+
+    def red(message)
+      colorize(message, 31)
+    end
+
+    def green(message)
+      colorize(message, 32)
+    end
+
+    def success_summary
+      "#{@success_count} #{'seed'.pluralize(@success_count)} successfully planted."
+    end
+
+    def error_summary
+      "#{@error_count} #{'seed'.pluralize(@error_count)} couldn't be planted:"
+    end
+  end
+end

data/lib/sprig/sprig_record_store.rb

@@ -0,0 +1,31 @@
+require 'singleton'
+
+module Sprig
+  class SprigRecordStore
+    include Singleton
+
+    class RecordNotFoundError < StandardError;end
+
+    def save(record, sprig_id)
+      records_of_klass(record.class)[sprig_id.to_s] = record
+    end
+
+    def get(klass, sprig_id)
+      records_of_klass(klass)[sprig_id.to_s] || record_not_found
+    end
+
+    private
+
+    def records_of_klass(klass)
+      records[klass.name.tableize] ||= {}
+    end
+
+    def records
+      @records ||= {}
+    end
+
+    def record_not_found
+      raise(RecordNotFoundError, "Record for class #{klass} and sprig_id #{sprig_id} could not be found.")
+    end
+  end
+end

data/lib/sprig/version.rb

@@ -0,0 +1,3 @@
+module Sprig
+  VERSION = "0.1.0"
+end

data/spec/feature/configurations_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+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'
+
+    Sprig.configure do |c|
+      c.directory = 'seed_files'
+    end
+
+    Sprig.configuration.directory.to_path.should == '~/seed_files/development'
+  end
+
+  it "can reset the configuration" do
+    Sprig.configure do |c|
+      c.directory = 'seed_files'
+    end
+
+    Sprig.configuration.directory.to_path.should == '~/seed_files/development'
+
+    Sprig.reset_configuration
+
+    Sprig.configuration.directory.to_path.should == '~/db/seeds/development'
+  end
+end

data/spec/fixtures/cassettes/google_spreadsheet_json_posts.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://spreadsheets.google.com/feeds/list/0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E/1/public/values?alt=json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Expires:
+      - Thu, 02 Jan 2014 22:06:43 GMT
+      Date:
+      - Thu, 02 Jan 2014 22:06:43 GMT
+      Cache-Control:
+      - private, max-age=0, must-revalidate, no-transform
+      Vary:
+      - Accept, X-GData-Authorization, GData-Version
+      Gdata-Version:
+      - '1.0'
+      Last-Modified:
+      - Thu, 02 Jan 2014 21:46:27 GMT
+      Set-Cookie:
+      - NID=67=twk9_9Iqw6h1ZztnpEkt7dtJJIvFCbyeEjQhC5XRwV7jMa4uPJoArpItl5KnmhwPif-owRtCYsUwyChgEMO7GDroZPOFBOV0KvMLzUQmlSn-0tGxTefBSvdVHJ8MIHsi;Domain=.google.com;Path=/;Expires=Fri,
+        04-Jul-2014 22:06:43 GMT;HttpOnly
+      P3p:
+      - CP="This is not a P3P policy! See http://www.google.com/support/accounts/bin/answer.py?hl=en&answer=151657
+        for more info."
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      Server:
+      - GSE
+      Alternate-Protocol:
+      - 443:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: US-ASCII
+      string: ! '{"version":"1.0","encoding":"UTF-8","feed":{"xmlns":"http://www.w3.org/2005/Atom","xmlns$openSearch":"http://a9.com/-/spec/opensearchrss/1.0/","xmlns$gsx":"http://schemas.google.com/spreadsheets/2006/extended","id":{"$t":"https://spreadsheets.google.com/feeds/list/0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E/1/public/values"},"updated":{"$t":"2014-01-02T21:46:27.808Z"},"category":[{"scheme":"http://schemas.google.com/spreadsheets/2006","term":"http://schemas.google.com/spreadsheets/2006#list"}],"title":{"type":"text","$t":"Sheet1"},"link":[{"rel":"alternate","type":"text/html","href":"https://spreadsheets.google.com/pub?key\u003d0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E"},{"rel":"http://schemas.google.com/g/2005#feed","type":"application/atom+xml","href":"https://spreadsheets.google.com/feeds/list/0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E/1/public/values"},{"rel":"self","type":"application/atom+xml","href":"https://spreadsheets.google.com/feeds/list/0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E/1/public/values?alt\u003djson"}],"author":[{"name":{"$t":"ryan.foster"},"email":{"$t":"ryan.foster@viget.com"}}],"openSearch$totalResults":{"$t":"1"},"openSearch$startIndex":{"$t":"1"},"entry":[{"id":{"$t":"https://spreadsheets.google.com/feeds/list/0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E/1/public/values/cokwr"},"updated":{"$t":"2014-01-02T21:46:27.808Z"},"category":[{"scheme":"http://schemas.google.com/spreadsheets/2006","term":"http://schemas.google.com/spreadsheets/2006#list"}],"title":{"type":"text","$t":"1"},"content":{"type":"text","$t":"title:
+        Google spreadsheet json title, content: Google spreadsheet json content"},"link":[{"rel":"self","type":"application/atom+xml","href":"https://spreadsheets.google.com/feeds/list/0AjVLPMnHm86rdDVHQ2dCUS03RTN5ZUtVNzVOYVBwT0E/1/public/values/cokwr"}],"gsx$sprig-id":{"$t":"1"},"gsx$title":{"$t":"Google
+        spreadsheet json title"},"gsx$content":{"$t":"Google spreadsheet json content"}}]}}'
+    http_version:
+  recorded_at: Thu, 02 Jan 2014 22:06:42 GMT
+recorded_with: VCR 2.8.0

data/spec/fixtures/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+  belongs_to :post
+
+  validates :post, :presence => true
+end

data/spec/fixtures/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

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

@@ -0,0 +1,6 @@
+# posts.yml
+
+records:
+  - sprig_id: 1
+    title: 'Staging yaml title'
+    content: 'Staging yaml content'

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

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

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

@@ -0,0 +1,6 @@
+# posts.yml
+
+records:
+  - sprig_id: 'l_1'
+    title: 'Legacy yaml title'
+    content: 'Legacy yaml content'

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

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

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

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

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

@@ -0,0 +1,6 @@
+# posts.yml
+
+records:
+  - sprig_id: 1
+    title: 'Yaml title'
+    content: 'Yaml content'

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

@@ -0,0 +1,9 @@
+# posts_find_existing_by_multiples.yml
+options:
+  find_existing_by: ['title', 'content']
+
+records:
+  - sprig_id: 1
+    title: 'Existing title'
+    content: 'Existing content'
+    published: true

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

@@ -0,0 +1,8 @@
+# posts_find_existing_by_single.yml
+options:
+  find_existing_by: 'title'
+
+records:
+  - sprig_id: 1
+    title: 'Existing title'
+    content: 'Updated content'

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

@@ -0,0 +1,7 @@
+# posts_missing_dependency.yml
+
+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/lib/sprig/configuration_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Sprig::Configuration do
+  before do
+    stub_rails_root '~'
+    stub_rails_env 'development'
+  end
+
+  describe "#directory" do
+
+    it "returns db/seeds/:env by default" do
+      subject.directory.to_path.should == '~/db/seeds/development'
+    end
+
+    it "returns a custom directory" do
+      subject.directory = 'seed_files'
+
+      subject.directory.to_path.should == '~/seed_files/development'
+    end
+  end
+end

data/spec/lib/sprig/directive_list_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Sprig::DirectiveList do
+
+  describe "#add_seeds_to_hopper" do
+    let(:hopper)       { Array.new }
+    let(:directive)    { double('directive') }
+    let(:seed_factory) { double('seed_factory') }
+
+    subject { described_class.new(Post) }
+
+    before do
+      Sprig::Directive.stub(:new).with(Post).and_return(directive)
+
+      Sprig::Seed::Factory.stub(:new_from_directive).with(directive).and_return(seed_factory)
+    end
+
+    it "builds seeds from directives and adds to the given array" do
+      seed_factory.should_receive(:add_seeds_to_hopper).with(hopper)
+
+      subject.add_seeds_to_hopper(hopper)
+    end
+  end
+end