seeder 0.1.3 → 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5611b4210e0232e190e6a834a990a450a3f8a97
+  data.tar.gz: b4f69c31fe5f82988f4e8174ad6f9f5349ae07a5
+SHA512:
+  metadata.gz: cb23ee0d4e02b6656024bad8cf34229d115e74dfe7553adccdb5424297aad92a4271c70e95e03601a4b60e7b59ac236ba466112efbf1a57ef7707300105ec92f
+  data.tar.gz: 39ce51f9890f2183e46d1845bb3a939a31c955dfbb4aee24b4803b3427ee870b3e2919c7382242337ceb4a6f7c215d5c65cf4bbe55a61bc6830075d8fa366da8

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - 2.2.3
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  matrix:
+    - AR=3.2.18
+    - AR=4.0.5
+    - AR=4.1.1
+    - AR=4.2.5
+before_script:
+  - mysql -e 'create database seeder_test;'

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+gemspec
+
+# The AR environment variable lets you test against different
+# versions of Rails. For example:
+#
+#  AR=3.2.13 rm Gemfile.lock && bundle install && bundle exec rspec
+#  AR=4.0.0  rm Gemfile.lock && bundle install && bundle exec rspec
+#
+if ENV['AR']
+  gem 'activerecord', ENV['AR']
+end

data/README.md

@@ -1,49 +1,95 @@
-Description
-===========
+# seeder
 
-Seeder provides a way for your app to plant seed data in its database.
-It respects unique keys in your database, so that it does the equivalent of
-MySQL's "on duplicate key update" (but this is database agnostic)
+Seeder provides a way for your app to plant seed data in its database. A
+primary benefit of using this gem is that it gives you an easy way to manage
+updating and deleting seed data, in addition to just creating it.
 
+## Install
 
-Install
-=======
+```
+gem install seeder
+```
+
+## Motivation
+
+Seed data refers to data stored in your database that is not generated
+dynamically through your application. You can generate your seed data via
+`rake db:seed`, which runs the contents of your `db/seeds.rb` file.
+
+Generating seed data is easy enough. But as your application grows and
+changes, you may find that you need to modify existing seed data.
+
+You could run migrations to modify seed data, but you would need to make sure
+to adjust the seeds.rb file in a consistent way. It is very easy to forget to
+do this, or to make a mistake along the way.
+
+Seeder allows you to manage all of your seeds via the seeds.rb file, without
+needing to use migrations when you have to change existing seed data.
+
+You provide a set of attributes associated with your seed data for a given
+model. You also specify which attributes of the model should be treated as
+"identifying attributes" - that is, which attributes should be used to
+determine if an existing database row needs to be updated, or if a new row
+needs to be added. Seeder then synchronizes the contents of the database table
+to the attributes it is given.
+
+## Usage
+
+Suppose you have a `DataField` model, with attributes `data_type`, `name`, and
+`description`.
 
-    $ gem install seeder
+To seed your database with a couple data fields, you would just include the
+following in your seeds.rb file:
 
-Usage
-=====
+```ruby
+seeds = [
+  { data_type: "Oil", name: "btu", description: "Oil usage" },
+  { data_type: "Water", name: "gallons", description: "Water usage" }
+]
+
+Seeder.create(seeds, [:data_type, :name], DataField)
+```
+
+In the example above, the `data_type` and `name` attributes will be used to
+identify records that already exist in the database. The first time you seed
+data, there are no existing records so two new records will be created. If you
+re-seed the database, Seeder will not do anything, since the records already
+exist in the database, and no attributes have changed.
 
-Suppose you have a `User` model
+Suppose the database has already been seeded, and you decide to change the
+description of the Oil btu data field. All you need to do is update the
+seeds.rb file and rerun the `db:seed` Rake task. Seeder will know to update the
+_existing_ database record associated with Oil btu:
 
-And suppose that user model has fields "name", "age", "address", "gender"
+```ruby
+seeds = [
+  { data_type: "Oil", name: "btu", description: "Fuel oil usage" },
+  { data_type: "Water", name: "gallons", description: "Water usage" }
+]
 
-Finally, suppose you've set up your database to have a unique key on the fields
-"name" and "address" (so two people can have the same name or live at the
-same address, but not both)
+Seeder.create(seeds, [:data_type, :name], DataField)
+```
 
-If you wanted to seed your data with a couple users you could do the following:
+If you then want to add an Oil therms DataField record to the db, you could
+just add a line to your seeds.rb file:
 
 ```ruby
-seed_users = [
-  {
-    :name => "J'onn J'onzz",
-    :age => 94,
-    :address => 'Mars',
-    :gender => 'Male'
-  },
-  {
-    :name => "Barbara Gordon",
-    :age => 35,
-    :address => '14 Gotham Heights',
-    :gender => 'Female'
-  }
+seeds = [
+  { data_type: "Oil", name: "btu", description: "Fuel oil usage (btu)" },
+  { data_type: "Oil", name: "therms", description: "Fuel oil usage (therms)" },
+  { data_type: "Water", name: "gallons", description: "Water usage" }
 ]
 
-SeedData.create {'User' => seed_users}, [:name, :address], User
+Seeder.create(seeds, [:data_type, :name], DataField)
 ```
 
-License
-=======
+The above code would adjust the description of the existing Oil btu database
+row, and create a new one for Oil therms.
+
+Now let's say you changed your mind and decided that you don't need an
+Oil therms entry in the database. You could just delete the corresponding row
+from seeds.rb, and Seeder will know to delete that entry from the database.
+
+## License
 
 See LICENSE.txt

data/Rakefile

@@ -1,36 +1,3 @@
-require 'rake'
-require 'fileutils'
-
-def gemspec_name
-  @gemspec_name ||= Dir['*.gemspec'][0]
-end
-
-def gemspec
-  @gemspec ||= eval(File.read(gemspec_name), binding, gemspec_name)
-end
-
-desc "Build the gem"
-task :gem=>:gemspec do
-  sh "gem build #{gemspec_name}"
-  FileUtils.mkdir_p 'pkg'
-  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
-end
-
-desc "Install the gem locally"
-task :install => :gem do
-  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
-end
-
-desc "Generate the gemspec"
-task :generate do
-  puts gemspec.to_ruby
-end
-
-desc "Validate the gemspec"
-task :gemspec do
-  gemspec.validate
-end
-
 desc 'Run tests'
 task :test do |t|
   sh 'rspec spec'

data/lib/seeder.rb

@@ -1,78 +1,66 @@
 class Seeder
+  attr_reader :keys, :data, :model
 
-  class << self
-    QUOTING = {
-      "ActiveRecord::ConnectionAdapters::MysqlAdapter"  => "`",
-      "ActiveRecord::ConnectionAdapters::Mysql2Adapter" => "`"
-    }
+  def self.create(data, keys, model)
+    new(data, keys, model).create
+  end
 
-    def existing_data_keys(ar_model)
-      keys = @primary_keys[ar_model.name]
-      ar_model.all.map{|item| item.attributes.symbolize_keys.values_at(*keys) }
-    end
+  def initialize(data, keys, model)
+    @keys = keys.map(&:to_sym)
+    @data = data.map(&:symbolize_keys)
+    @model = model
+  end
 
-    def seed_data_keys(ar_model)
-      keys = @primary_keys[ar_model.name]
-      @data[ar_model.name].collect{|attributes| attributes.values_at(*keys) }
+  def create
+    model.transaction do
+      delete_outdated_records
+      update_existing_records
+      create_new_records
     end
+  end
 
-    def items_to_delete(ar_model)
-      existing_data_keys(ar_model) - seed_data_keys(ar_model)
-    end
+  def delete_outdated_records
+    return unless records_to_delete.present?
+    model.where(id: records_to_delete).delete_all
+  end
 
-    def value_to_sql(value)
-      if value.nil? then 'NULL'
-      elsif value.is_a?(String) then "'#{value}'"
-      elsif value == false then 0
-      elsif value == true then 1
-      else value
-      end
-    end
+  def update_existing_records
+    existing_records_keys_hash.each do |record_keys, record|
+      attributes = data_keys_hash[record_keys]
+      next unless attributes
 
-    def quote(value)
-      q = QUOTING[ActiveRecord::Base.connection.class.to_s] || '"'
-      "#{q}#{value}#{q}"
+      record.attributes = attributes
+      record.save! if record.changed?
     end
+  end
 
-    def add_new_or_changed_data(ar_model)
-      keys = @primary_keys[ar_model.name]
-      find_method = "find_by_#{keys.join('_and_')}"
-
-      @data[ar_model.name].collect do |attributes|
-        relevant_keys = attributes.keys & ar_model.column_names.map(&:to_sym)
-        existing = ar_model.send(find_method, *attributes.values_at(*keys))
-        values = attributes.values_at(*relevant_keys)
+  def create_new_records
+    new_keys = data_keys_hash.keys - existing_records_keys_hash.keys
 
-        if existing
-          updates    = attributes.slice(*relevant_keys).map { |k,v| "#{quote(k)} = #{value_to_sql(v)}" }.join(", ")
-          conditions = keys.map { |k| "#{quote(k)} = #{value_to_sql(existing.send(k))}" }.join(" AND ")
-          %(UPDATE #{ar_model.table_name} SET #{updates} WHERE #{conditions})
-        else
-          columns = relevant_keys.map { |k| quote(k) }.join(", ")
-          inserts = attributes.slice(*relevant_keys).values.map { |v| value_to_sql(v) }.join(", ")
-          %(INSERT INTO #{ar_model.table_name} (#{columns}) VALUES (#{inserts}))
-        end
-      end.compact
+    data_keys_hash.values_at(*new_keys).each do |attributes|
+      model.create!(attributes)
     end
+  end
 
-    def delete_outdated_data(ar_model)
-      keys = @primary_keys[ar_model.name]
-      items_to_delete(ar_model).collect do |field_to_delete|
-        conditions = field_to_delete.to_enum.with_index.collect{|value, index| "#{keys[index]} = '#{value}'"}.join(' AND ')
-        %{ DELETE FROM #{ar_model.table_name} WHERE #{conditions} }
-      end.compact
+  private
+
+  def data_keys_hash
+    @data_keys_hash ||= data.inject({}) do |hash, attributes|
+      hash.merge!(attributes.values_at(*keys) => attributes)
     end
+  end
 
-    def create(data, keys, models)
-      @data, @primary_keys = data, keys
-      models.each {|model|
-        delete_outdated_data(model).each{|query| sql(query)}
-        add_new_or_changed_data(model).each{|query| sql(query)}
-      }
+  def existing_records_keys_hash
+    @existing_records_keys_hash ||= model.all.inject({}) do |hash, record|
+      record_keys = keys.map { |key| record.public_send(key) }
+      hash.merge!(record_keys => record)
     end
+  end
 
-    def sql(sql_command)
-      ActiveRecord::Base.connection.execute(sql_command)
+  def records_to_delete
+    @records_to_delete ||= begin
+      keys_to_delete = existing_records_keys_hash.keys - data_keys_hash.keys
+      existing_records_keys_hash.values_at(*keys_to_delete)
     end
   end
 end

data/lib/seeder/version.rb

@@ -1,3 +1,3 @@
 class Seeder
-  VERSION = '0.1.3'
+  VERSION = '1.0'
 end

data/seeder.gemspec

@@ -3,16 +3,20 @@ require 'rubygems' unless defined? Gem
 require File.dirname(__FILE__) + "/lib/seeder/version"
 
 Gem::Specification.new do |s|
-  s.name        = "seeder"
-  s.version     = Seeder::VERSION
-  s.authors     = ["Barun Singh", "Gabriel Horner"]
-  s.email       = "bsingh@wegowise.com"
-  s.homepage    = "http://github.com/wegowise/seeder"
-  s.summary = "Seed your data"
-  s.description =  "Keep your app's seed data in one file and update it easily, while respecting key constraints"
+  s.name = "seeder"
+  s.version = Seeder::VERSION
+  s.authors = ["Barun Singh"]
+  s.email = "bsingh@wegowise.com"
+  s.homepage = "http://github.com/wegowise/seeder"
+  s.summary = "Manage seed data for your Rails app"
+  s.description = "Keep your app's seed data in one file and update it easily"
   s.required_rubygems_version = ">= 1.3.6"
-  s.files = Dir.glob(%w[{lib,spec}/**/*.rb [A-Z]*.{txt,rdoc,md} *.gemspec]) + %w{Rakefile}
+  s.files = `git ls-files`.split("\n")
   s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
   s.license = 'MIT'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
+
+  s.add_dependency('activerecord', '>= 3.2', '< 5.0')
+
+  s.add_development_dependency('mysql2', '~> 0.3.10')
+  s.add_development_dependency('rspec-rails', '~> 3.0')
 end

data/spec/seeder_spec.rb

@@ -0,0 +1,108 @@
+require 'active_record'
+require 'support/setup'
+require 'seeder'
+
+describe Seeder do
+  before(:each) { Grade.delete_all }
+
+  let(:seeder) do
+    Seeder.new(
+      [{ 'student_id' => 1, 'course_id' => 1, 'grade' => 90 },
+       { 'student_id' => 1, 'course_id' => 2, 'grade' => 80 }],
+      %w[student_id course_id],
+      Grade
+    )
+  end
+
+  describe '.create' do
+    it 'should call create on a new instance' do
+      seeder = double
+      expect(Seeder).to receive(:new).with(:data, :keys, :model)
+        .and_return(seeder)
+      expect(seeder).to receive(:create)
+
+      Seeder.create(:data, :keys, :model)
+    end
+  end
+
+  describe '#new' do
+    specify { expect(seeder.model).to eq Grade }
+    specify { expect(seeder.keys).to eq [:student_id, :course_id] }
+    specify do
+      expect(seeder.data).to eq(
+        [{ student_id: 1, course_id: 1, grade: 90 },
+         { student_id: 1, course_id: 2, grade: 80 }]
+      )
+    end
+  end
+
+  describe '#delete_outdated_records' do
+    before do
+      Grade.create!(student_id: 1, course_id: 3)
+      Grade.create!(student_id: 1, course_id: 1)
+    end
+
+    it 'should delete outdated records' do
+      expect { seeder.delete_outdated_records }.to change { Grade.count }.to(1)
+      expect(Grade.first.course_id).to eq 1
+    end
+  end
+
+  describe '#update_existing_records' do
+    let!(:existing_grade) { Grade.create!(student_id: 1, course_id: 1) }
+
+    it 'should delete outdated records' do
+      expect { seeder.update_existing_records }
+        .to change { existing_grade.reload.grade }.to(90)
+    end
+  end
+
+  describe '#create_new_records' do
+    let!(:existing_grade) { Grade.create!(student_id: 1, course_id: 1) }
+
+    it 'should create new records when there are no existing records with
+    matching keys' do
+      expect { seeder.create_new_records }.to change { Grade.count }.to(2)
+      expect(Grade.last.course_id).to eq 2
+    end
+  end
+
+  describe '#create' do
+    it 'calls the delete, update and create methods in order' do
+      expect(seeder).to receive(:delete_outdated_records).ordered
+      expect(seeder).to receive(:update_existing_records).ordered
+      expect(seeder).to receive(:create_new_records).ordered
+      seeder.create
+    end
+
+    it 'aborts when an exception is raised' do
+      expect(seeder).to receive(:create_new_records).and_raise
+      initial_attributes = Grade.all.map(&:attributes)
+
+      expect { seeder.create }.to raise_error
+
+      expect(Grade.all.map(&:attributes)).to eq(initial_attributes)
+    end
+
+    it 'produces the appropriate results' do
+      grade1 = Grade.create!(student_id: 1, course_id: 3)
+      grade2 = Grade.create!(student_id: 1, course_id: 1)
+
+      seeder.create
+
+      expect(Grade.count).to eq(2)
+      expect(Grade.exists?(grade1)).to eq(false)
+
+      grade2.reload
+      expect(grade2.student_id).to eq(1)
+      expect(grade2.course_id).to eq(1)
+      expect(grade2.grade).to eq(90)
+
+      grade3 = Grade.last
+      expect(grade3.student_id).to eq(1)
+      expect(grade3.course_id).to eq(2)
+      expect(grade3.grade).to eq(80)
+    end
+  end
+
+end

data/spec/support/setup.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Base.establish_connection({
+  adapter: 'mysql2',
+  username: 'travis',
+  database: 'seeder_test'
+})
+
+ActiveRecord::Base.connection.tables.each do |table|
+  ActiveRecord::Base.connection.drop_table table
+end
+
+ActiveRecord::Schema.define do
+  create_table :grades do |t|
+    t.integer :student_id
+    t.integer :course_id
+    t.integer :grade
+  end
+end
+
+class Grade < ActiveRecord::Base
+end

metadata

@@ -1,30 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: seeder
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: '1.0'
 platform: ruby
 authors:
 - Barun Singh
-- Gabriel Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-20 00:00:00.000000000Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2165419640 !ruby/object:Gem::Requirement
-    none: false
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.10
   type: :development
   prerelease: false
-  version_requirements: *2165419640
-description: Keep your app's seed data in one file and update it easily, while respecting
-  key constraints
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.10
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Keep your app's seed data in one file and update it easily
 email: bsingh@wegowise.com
 executables: []
 extensions: []
@@ -32,36 +66,40 @@ extra_rdoc_files:
 - README.md
 - LICENSE.txt
 files:
-- lib/seeder/version.rb
-- lib/seeder.rb
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.txt
+- Gemfile
 - LICENSE.txt
 - README.md
-- seeder.gemspec
 - Rakefile
+- lib/seeder.rb
+- lib/seeder/version.rb
+- seeder.gemspec
+- spec/seeder_spec.rb
+- spec/support/setup.rb
 homepage: http://github.com/wegowise/seeder
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
-summary: Seed your data
+specification_version: 4
+summary: Manage seed data for your Rails app
 test_files: []